/* Copyright (c) 2007  Peter Palotas
 *  
 *  This software is provided 'as-is', without any express or implied
 *  warranty. In no event will the authors be held liable for any damages
 *  arising from the use of this software.
 *  
 *  Permission is granted to anyone to use this software for any purpose,
 *  including commercial applications, and to alter it and redistribute it
 *  freely, subject to the following restrictions:
 *  
 *      1. The origin of this software must not be misrepresented; you must not
 *      claim that you wrote the original software. If you use this software
 *      in a product, an acknowledgment in the product documentation would be
 *      appreciated but is not required.
 *  
 *      2. Altered source versions must be plainly marked as such, and must not be
 *      misrepresented as being the original software.
 *  
 *      3. This notice may not be removed or altered from any source
 *      distribution.
 *  
 *  
 *  $Id: WordWrappingMethod.cs 19 2007-08-15 13:14:32Z palotas $
 */
using System;
using System.Collections.Generic;
using System.Text;

namespace Plossum
{
    /// <summary>
    /// Represents the word wrapping method to use for various operations performed by <see cref="StringFormatter"/>.
    /// </summary>
    public enum WordWrappingMethod
    {
        /// <summary>
        /// Uses a greedy algorithm for performing the word wrapping, 
        /// that puts as many words on a line as possible, then moving on to the next line to do the 
        /// same until there are no more words left to place.
        /// </summary>
        /// <remarks>This is the fastest method, but will often create a less esthetically pleasing result than the
        /// <see cref="Optimal"/> method.</remarks>
        Greedy,
        /// <summary>
        /// Uses an algorithm attempting to create an optimal solution of breaking the lines, where the optimal solution is the one
        /// where the remaining space on the end of each line is as small as possible.
        /// </summary>
        /// <remarks>This method creates esthetically more pleasing results than those created by the <see cref="Greedy"/> method, 
        /// but it does so at a significantly slower speed.  This method will work fine for wrapping shorter strings for console 
        /// output, but should probably not be used for a real time WYSIWYG word processor or something similar.</remarks>
        Optimal
    }
}
